-
Notifications
You must be signed in to change notification settings - Fork 1.7k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Require an introductory paragraph in docs pages #43222
base: master
Are you sure you want to change the base?
Conversation
The PR changelog entry failed validation: Changelog entry not found in the PR body. Please add a "no-changelog" label to the PR, or changelog lines starting with |
4e5f3e2
to
79f21f7
Compare
The PR changelog entry failed validation: Changelog entry not found in the PR body. Please add a "no-changelog" label to the PR, or changelog lines starting with |
79f21f7
to
c5bb5fa
Compare
The PR changelog entry failed validation: Changelog entry not found in the PR body. Please add a "no-changelog" label to the PR, or changelog lines starting with |
c5bb5fa
to
ff07826
Compare
The PR changelog entry failed validation: Changelog entry not found in the PR body. Please add a "no-changelog" label to the PR, or changelog lines starting with |
ff07826
to
6217c60
Compare
The PR changelog entry failed validation: Changelog entry not found in the PR body. Please add a "no-changelog" label to the PR, or changelog lines starting with |
6217c60
to
f4cde12
Compare
The PR changelog entry failed validation: Changelog entry not found in the PR body. Please add a "no-changelog" label to the PR, or changelog lines starting with |
dfa1559
to
d26dd16
Compare
7514af8
to
1544df5
Compare
0c08c06
to
6663378
Compare
63ee403
to
7c6cb17
Compare
dd5bdb9
to
9f8bb8d
Compare
9a31d76
to
d93c551
Compare
7d221d7
to
24c435c
Compare
24c435c
to
6dbbde7
Compare
Add a vale rule that requires there to be a paragraph between the second frontmatter document separator (`---`) and the first H2-level heading of a docs page. Introductory paragraphs are common omissions in docs pages, but are important to help readers determine whether a guide is appropriate for their use case.
6dbbde7
to
e0ba9e1
Compare
🤖 Vercel preview here: https://docs-kezdogbvy-goteleport.vercel.app/docs/ver/preview |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nice!
@eglenn-teleport This should help address an issue you raised re: docs pages missing introductions. |
Add a vale rule that requires there to be a paragraph between the second frontmatter document separator (
---
) and the first H2-level heading of a docs page. Introductory paragraphs are common omissions in docs pages, but are important to help readers determine whether a guide is appropriate for their use case.